﻿//
// ICommand.cs
//
// Authors:
//  Kenny York <kennyyork@gmail.com>
//
// Copyright (C) 2009 Kenny York
//
// Permission is hereby granted, free of charge, to any person obtaining
// a copy of this software and associated documentation files (the
// "Software"), to deal in the Software without restriction, including
// without limitation the rights to use, copy, modify, merge, publish,
// distribute, sublicense, and/or sell copies of the Software, and to
// permit persons to whom the Software is furnished to do so, subject to
// the following conditions:
// 
// The above copyright notice and this permission notice shall be
// included in all copies or substantial portions of the Software.
// 
// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
// EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
// MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
// NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
// LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
// OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
// WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
//

using System;
using System.Collections.Generic;
using System.Linq;
using System.Text;

namespace clidotnet
{
    /// <summary>
    /// Interface defining a basic command
    /// </summary>
    public interface ICommand
    {
        /// <summary>
        /// The name of the command.  This will be uses to look up and execute the command's ation
        /// </summary>
        string Name { get; }

        /// <summary>
        /// Help string describing what the command does
        /// </summary>
        string Help { get; }

        /// <summary>
        /// Execute the command with the provided parameters
        /// </summary>
        /// <param name="args"></param>
        /// <returns>Returns true if the command was successfully executed.</returns>
        void Execute(List<string> args);
        
        /// <summary>
        /// Compare two ICommand objects for equality (duplication avoidance)
        /// </summary>
        /// <param name="command"></param>
        /// <returns>Returns true if the two commands are equivilent.</returns>
        bool Equals(ICommand command);
        
        /// <summary>
        /// Does the ICommand implement the given command name
        /// </summary>
        /// <param name="name"></param>
        /// <returns>Returns true if </returns>
        ICommand Implements(string command, List<string> args);

        bool Implements(string command);
    }
}
